Skip to main content

First Time Contributors

Unsure where to begin contributing? You can start by looking through these beginner and help-wanted issues:

  • First Timers - issues specific for first time github users, designed and created to guide you through contributing.
  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted - issues which should be a bit more involved than beginner issues.

Your first project

Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub

At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first!

If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge. Note that we do provide an automatic command for this which can be attempted through commenting /rebase.

Creating a merge request

When you believe you have completed your contribution, you will need to make an pull request. This should be simple for most users, and we have provided some templates for you to get started, however if you choose to create your pull request from scratch, please ensure the following steps are followed.

Titling your request​

We use conventional commits format when creating pull requests, this is so we can squash all pull requests when merging and automatically create our changelog and releases. To ensure that this convention is completed, our automation will fail if the title does not follow this standard.

Prefixes​

If you are still working on your pull request, please ensure that you prefix it with WIP: to ensure that the pull isn't accidently merged before it's ready.